'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH DI_WALK_MINOR 3DEVINFO "Jan 14, 2009"
.SH NAME
di_walk_minor \- traverse libdevinfo minor nodes
.SH SYNOPSIS
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ]
#include <libdevinfo.h>

\fBint\fR \fBdi_walk_minor\fR(\fBdi_node_t\fR \fIroot\fR, \fBconst char *\fR\fIminor_nodetype\fR,
     \fBuint_t\fR \fIflag\fR, \fBvoid *\fR\fIarg\fR, \fBint\fR (\fI*minor_callback\fR)(di_node_t \fInode\fR,
     di_minor_t \fIminor\fR, void *\fIarg\fR));
.fi

.SH PARAMETERS
.ne 2
.na
\fB\fIarg\fR\fR
.ad
.RS 18n
Pointer to caller- specific user data.
.RE

.sp
.ne 2
.na
\fB\fIflag\fR\fR
.ad
.RS 18n
Specify 0. Reserved for future use.
.RE

.sp
.ne 2
.na
\fB\fIminor\fR\fR
.ad
.RS 18n
The minor node visited.
.RE

.sp
.ne 2
.na
\fB\fIminor_nodetype\fR\fR
.ad
.RS 18n
A character string specifying the minor data type, which may be one of the
types defined by the illumos DDI framework, for example, \fBDDI_NT_BLOCK\fR.
\fBNULL\fR matches all \fIminor_node\fR  types. See
\fBddi_create_minor_node\fR(9F).
.RE

.sp
.ne 2
.na
\fB\fInode\fR\fR
.ad
.RS 18n
The device node with which to  the minor node is associated.
.RE

.sp
.ne 2
.na
\fB\fIroot\fR\fR
.ad
.RS 18n
Root of subtree to visit.
.RE

.SH DESCRIPTION
The \fBdi_walk_minor()\fR function visits all minor nodes attached to device
nodes in a subtree rooted at \fIroot\fR. For each  minor node that matches
\fIminor_nodetype\fR, the caller-supplied function \fIminor_callback\fR() is
invoked. The walk terminates immediately when \fIminor_callback\fR() returns
\fBDI_WALK_TERMINATE\fR.
.SH RETURN VALUES
Upon successful completion, \fBdi_walk_minor()\fR returns 0. Otherwise, -1 is
returned and errno is set to indicate the error.
.sp
.LP
The \fBminor_callback()\fR function returns one of the following:
.sp
.ne 2
.na
\fB\fBDI_WALK_CONTINUE\fR\fR
.ad
.RS 21n
Continue to visit subsequent minor data nodes.
.RE

.sp
.ne 2
.na
\fB\fBDI_WALK_TERMINATE\fR\fR
.ad
.RS 21n
Terminate the walk immediately.
.RE

.SH ERRORS
The \fBdi_walk_minor()\fR function will fail if:
.sp
.ne 2
.na
\fB\fBEINVAL\fR\fR
.ad
.RS 10n
Invalid argument.
.RE

.SH ATTRIBUTES
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	Safe
.TE

.SH SEE ALSO
\fBdladm\fR(8), \fBdi_minor_nodetype\fR(3DEVINFO), dlpi_walk(3DLPI),
.BR libdevinfo (3LIB),
.BR attributes (7),
.BR filesystem (7),
.BR ddi_create_minor_node (9F)
.sp
.LP
\fIWriting Device Drivers\fR
.SH NOTES
The \fBdi_walk_minor()\fR function is no longer an accurate method for walking
network datalink interfaces on the system. Applications should use
\fBdlpi_walk\fR(3DLPI) instead. It has been common for applications to use
\fBdi_walk_minor()\fR to walk networking devices by passing in a
\fBminor_nodetype\fR of \fBDDI_NT_NET\fR, in most cases to discover the set of
DLPI devices on the system. illumos now makes a layering distinction between
networking devices (the objects displayed in the \fBDEVICE\fR field by
\fBdladm\fR \fBshow-phys\fR) and network datalink interfaces (the objects
displayed by \fBdladm\fR \fBshow-link\fR). Datalink interfaces are represented
as the set of DLPI device nodes that applications can open by using
\fBdlpi_open\fR(3DLPI) or by opening DLPI nodes out of the \fB/dev/net\fR
filesystem (see \fBfilesystem\fR(7)). The \fBdlpi_walk\fR(3DLPI) function is
the proper function to walk these nodes.
